Lender Price API Web Service
Lender Price API Web Service / CompanyUserGroup Json Schema
In This Topic
    CompanyUserGroup Json Schema
    In This Topic
    Overview
    CompanyUserGroup
    autoGenerateRateSheets : boolean
    basePointRoundingStrategy : string
    branchContacts : Array[ContactPerson]
    branchNmlsId : string
    canViewAllRates : boolean
    capAdjustmentIds : Array[ObjectId]
    counter : integer
    internal only
    date : string

    The current date.

    internal only

    machineIdentifier : integer
    internal only
    processIdentifier : integer
    internal only
    time : integer
    internal only
    timeSecond : integer
    internal only
    timestamp : integer
    internal only
    closingCostSettings : Array[string]
    compPlanAdjustmentCodes : Array[string]
    compPlanAdjustmentIds : Array[ObjectId]
    compPlanDollarRange : CreditDollarRange
    companyAdjustmentGroups : Array[CompanyAdjustmentGroup]
    adjustmentCategoryType : string
    autoApplyToNewRateGrid : boolean
    adjustmentCategoryType : string
    autoApplyToNewRateGrid : boolean
    autoPushTime : string
    cloneId : ObjectId
    counter : integer
    internal only
    date : string

    The current date.

    internal only

    machineIdentifier : integer
    internal only
    processIdentifier : integer
    internal only
    time : integer
    internal only
    timeSecond : integer
    internal only
    timestamp : integer
    internal only
    code : string
    company : NmlsCompany
    active : boolean
    address : Address
    censustract : string
    Property ID in the national census data.
    city : string
    City where the property is located.
    country : string
    Country where the property is located.
    county : string

    County where the property is located.

    This is used for countyFips. The best practice is to pass to alleviate issues when the same zip/state spans > 1 county (counties may have different loan limits). 

    Must pass state fips + county fips.  Example, 25017 for Middlesex County, MA; 36103 for Suffolk, NY. 

    countyFips : string

    CountyFips ID.

    Populate this field if you are concerned that the state and zip area spans more than one county, in which case the API will only return the first county in the list. 

    countyName : string
    Name of the county the property is located in.
    defaultZipFipsComboOnMismatch : boolean
    latitude : number
    Property latitude.
    longitude : number
    Property longitude.
    msa : string
    province : string
    The province where the property is located.
    state : string

    The state where the property is located.

    Note:  if only state and zip are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list.  To avoid confusion, pass the countyFips.

    stateFips : string

    This field is DEFUNCT.

    DO NOT USE.

    street : string

    The first line of the property street address.

    Example: 10 Rose Court

    streetCont : string

    The second line of the property street address.

    Example: Apt. C

    zip : string

    The property zip code.

    Note: if only state and zip are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list.  To avoid confusion, pass the countyFips.

    zipExt : string

    The four digit zip code area extension. The dash is not necessary.

    Example: 2435

    Do not enter in this format: -2435

     

    allowPublicReview : boolean
    apiSecret : string
    armRoundedFullyIndexedRate : boolean
    authenticationURL : string
    autoExpireLoan : boolean
    autoSync : boolean
    batchPricingCallbackURL : string
    blacklisted : boolean
    blendIntegration : BlendIntegration
    active : boolean
    armFixedTermOptions : Array[AnswerOption]
    displayText : string
    value : string
    closestToPar : boolean
    closestToTargetValue : number
    closestToTargetValueFrom : number
    closestToTargetValueTo : number
    companyId : string
    companyName : string
    customQuestions : Array[Question]
    answerDataType : string
    answerOptions : Array[AnswerOption]
    controlType : string
    customQuestionId : string
    defaultAnswerValue : string
    displayText : string
    grouping : string
    hiddenInUserInterface : boolean
    intMaxValue : integer
    intMinValue : integer
    integrationFieldPath : string
    loanPurposes : Array[string]
    maxSelections : integer
    mergePriority : integer
    minSelections : integer
    order : integer
    path : string
    placeholder : string
    questionType : string
    readOnly : boolean
    required : boolean
    showCondition : QuestionShowCondition
    comparison : string
    customQuestionId : string
    integrationFieldPath : string
    value : string
    values : Array[string]
    stringMaxLength : integer
    stringMinLength : integer
    unusedByAdapter : boolean
    userType : string
    defaultAmortizationType : Array[string]
    defaultArmFixedTerms : Array[string]
    defaultDayLock : object
    defaultLoanTerms : Array[string]
    defaultMortgageTypes : Array[string]
    lenderpriceApiKey : string
    maxCompensation : number
    minimumCompensation : number
    originationFeeFromAdjustment : boolean
    purchaseAffordabilityProducts : Array[string]
    showDisqualify : boolean
    showDisqualifyRules : boolean
    tenantId : string
    tenantName : string
    useDefaultEstimatedMi : boolean
    useDisplayName : boolean
    userId : string
    blendIntegrations : Array[BlendIntegration]
    active : boolean
    armFixedTermOptions : Array[AnswerOption]
    closestToPar : boolean
    closestToTargetValue : number
    closestToTargetValueFrom : number
    closestToTargetValueTo : number
    companyId : string
    companyName : string
    customQuestions : Array[Question]
    defaultAmortizationType : Array[string]
    defaultArmFixedTerms : Array[string]
    defaultDayLock : object
    defaultLoanTerms : Array[string]
    defaultMortgageTypes : Array[string]
    lenderpriceApiKey : string
    maxCompensation : number
    minimumCompensation : number
    originationFeeFromAdjustment : boolean
    purchaseAffordabilityProducts : Array[string]
    showDisqualify : boolean
    showDisqualifyRules : boolean
    tenantId : string
    tenantName : string
    useDefaultEstimatedMi : boolean
    useDisplayName : boolean
    userId : string
    broker : boolean
    companyFeatures : CompanyFeatures
    creationDate : string
    features : Array[Feature]
    creationDate : string
    description : string
    modifiedByOverride : string
    name : string
    roles : Array[string]
    modifiedByOverride : string
    computeCompPlanWithTotalLoanAmt : boolean
    contactDetails : ContactDetails
    contactPerson : ContactPerson
    creationDate : string
    customFields : object
    customFiles : object
    dataWriteURL : string
    defaultDisclaimerId : ObjectId
    defaultTurnTimes : Array[TurnTime]
    defaultUserPictureLink : string
    demo : boolean
    ein : string
    ernstPassword : string
    ernstUserName : string
    expandedEligibilityHWURL : string
    expandedEligibilityURL : string
    externalLogo : string
    feeAPIURL : string
    feeAPIURLAlternate : string
    feeAPIURLBatch : string
    footerPhrase : string
    govtFeeAccess : GovtFeeAccess
    annualMiPremium : boolean
    fundingFee : boolean
    guaranteeFee : boolean
    ufmipFee : boolean
    handleLock : boolean
    headerPhrase : string
    includeExtendedRatesInLenderFilter : boolean
    jsonCustomFields : Array[JsField]
    key : string
    value : string
    jsonCustomFiles : Array[JsCompanyFieldFile]
    jsonSystemAdminFields : Array[JsField]
    ldapAPIURL : string
    lender : boolean
    linkSmoToDynamicFields : boolean
    loadLoanAPIURL : string
    mailingAddress : Address
    marketPlace : boolean
    marketPlaceNewUrl : string
    modifiedByOverride : string
    name : string
    nmlsId : string
    otherContacts : Array[ContactPerson]
    partnerData : PartnerData
    passwordExpirationDays : integer
    priceExceptionFormURL : string
    priceExceptionURL : string
    pricingConfiguration : PricingConfiguration
    computationService : string
    rateLimiterByFeature : object
    pricingProjection : Array[string]
    qmTreshold : Number
    rateSheetGeneratorConfig : CompanyRateSheetGeneratorConfig
    autoGenerateRateSheets : boolean
    notificationEmails : Array[string]
    rateSheetFilename : string
    rateSheetGenerationType : string
    separateByGroupId : boolean
    sftpDirectories : Array[string]
    sftpDirectory : string
    sftpHostname : string
    sftpPassword : string
    sftpSalt : string
    sftpUsername : string
    urlDomainDownload : string
    zipFilename : string
    zipFiles : boolean
    ratingSummary : RatingSummary
    scoreMap : object
    totalReviewScore : integer
    totalReviews : integer
    redirectAtLogin : boolean
    shortName : string
    ssoIdentifier : string
    tags : Array[string]
    userGroupMortgageMarketPlace : string
    website : string
    writebackURL : string
    companyId : ObjectId
    creationDate : string
    description : string
    disqualifyIfQualifier : boolean
    enabled : boolean
    encompassLink : boolean
    hasClone : boolean
    includeZeroValuedAdjustments : boolean
    loanInfoAdjustment : LoanInfoAdjustment
    maxCompensation : number
    maxCompensationDescription : string
    maxCompensationScript : string
    modifiedByOverride : string
    name : string
    order : integer
    originalCompanyAdjustmentGroupId : ObjectId
    ownerRatePeriodId : ObjectId
    public : boolean
    published : boolean
    rateAdjustmentType : string
    rateAdjustments : Array[RateAdjustment]
    showOnRateGenerator : boolean
    start : string
    updateDescription : string
    cloneId : ObjectId
    code : string
    company : NmlsCompany
    companyId : ObjectId
    creationDate : string
    description : string
    disqualifyIfQualifier : boolean
    enabled : boolean
    encompassLink : boolean
    hasClone : boolean
    includeZeroValuedAdjustments : boolean
    loanInfoAdjustment : LoanInfoAdjustment
    maxCompensation : number
    maxCompensationDescription : string
    maxCompensationScript : string
    modifiedByOverride : string
    name : string
    order : integer
    ownerRatePeriodId : ObjectId
    public : boolean
    published : boolean
    rateAdjustmentType : string
    rateAdjustments : Array[RateAdjustment]
    showOnRateGenerator : boolean
    start : string
    updateDescription : string
    companyAdjustmentGroupsLLPA : Array[CompanyAdjustmentGroup]
    companyAdjustmentGroupsRules : Array[CompanyAdjustmentGroup]
    companyId : ObjectId
    creationDate : string
    displayConventionalRate : boolean
    dynamicPropertiesMap : object
    e1003CompanyNmlsID : string
    e1003CompanyNmlsIdMappingList : Array[CompanyMapping]
    from : string
    to : string
    ellieMaeGroupCredentialPassword : string
    ellieMaeGroupCredentialUsername : string
    emailsMappedByFunction : object
    enabled : boolean
    encompassPersona : boolean
    encompassPriceGroup : boolean
    end : string
    externalId : string
    holdBack : number
    lockStatusPolicy : LockStatusPolicy
    autoExpired : boolean
    matchAll : boolean
    ruleGroupIds : Array[ObjectId]
    ruleGroups : Array[ChangeControlRuleGroup]
    creationDate : string
    description : string
    enabled : boolean
    matchAll : boolean
    modifiedByOverride : string
    name : string
    rules : Array[ChangeControlRule]
    matchBehavior : string
    name : string
    companyId : ObjectId
    creationDate : string
    disabledMessage : string
    enable : boolean
    expiredLockStatusId : ObjectId
    lockStatusConfig : LockStatusConfig
    costCenters : Array[string]
    eventTypeTriggerLimit : Array[EventTypeTriggerLimit]
    eventType : string
    triggerLimit : integer
    feeExceptionEnhancedMappedByGroup : object
    feeExceptionMappedByGroup : object
    gracePeriod : integer
    lockExtensionMappedByGroup : object
    lockStatusTriggerLimit : Array[LockStatusTriggerLimit]
    lockStatusList : Array[ObjectId]
    triggerLimit : integer
    maxDateExtension : integer
    priceExceptionEnhancedMappedByGroup : object
    priceExceptionMappedByGroup : object
    rateExceptionEnhancedMappedByGroup : object
    rateType : string
    reasons : Array[string]
    retainExtensionAndException : boolean
    subRateType : string
    variables : Array[LockPolicyVariable]
    initValue : integer
    key : string
    maxValue : integer
    name : string
    lockStatusList : Array[LockStatus]
    alert : boolean
    alertActors : Array[string]
    alertGroupIds : Array[ObjectId]
    allowDaylockOverride : boolean
    allowExpirationDateUpdate : boolean
    allowGracePeriodOverride : boolean
    allowLockDateUpdate : boolean
    allowPriceChange : boolean
    allowRevert : boolean
    allowRevertTo : Array[ObjectId]
    assignedVariables : Array[string]
    autoStatus : boolean
    autoStatusLockStatusId : ObjectId
    buttonName : string
    buySide : boolean
    code : string
    color : string
    creationDate : string
    deferredEntry : boolean
    description : string
    disabled : boolean
    eventType : string
    floatingEntry : boolean
    loanSupplyType : Array[string]
    lockException : LockException
    allowRme : boolean
    enable : boolean
    holdback : boolean
    lockExceptionMappedByGroup : object
    priceToFee : boolean
    requestType : string
    type : string
    types : Array[string]
    valueType : string
    lockExtender : LockExtender
    allowDailyFee : boolean
    allowOverride : boolean
    allowRme : boolean
    comment : string
    creationDate : string
    dailyFeeAmount : number
    enable : boolean
    lockExtensions : Array[LockExtension]
    creationDate : string
    days : integer
    modifiedByOverride : string
    points : number
    modifiedByOverride : string
    type : string
    useRateProgram : boolean
    lockStatusLogic : string
    mappingLos : Array[MappingLos]
    modifiedByOverride : string
    nextStatusIds : Array[ObjectId]
    order : integer
    primeState : boolean
    productCodes : Array[string]
    productCodesExclude : Array[string]
    renegotiationSettings : RenegotiationSettings
    defaultDayLockTerm : integer
    renegotiationFee : number
    renegotiationFeeAdjustmentType : string
    renegotiationFeeDayLock : object
    searchDefault : string
    repriceOutOfGroup : boolean
    repriceOutOfGroupTriggerWorseCase : boolean
    requireReprice : boolean
    root : boolean
    rules : Array[LockEventRule]
    actions : Array[RuleAction]
    conditions : Array[RuleCondition]
    operator : string
    value : integer
    variable : string
    statusFee : number
    visibleGroupIds : Array[ObjectId]
    worseCase : boolean
    worseCaseSettings : LockStatusWorseCase
    applyOriginalComp : boolean
    currentRateSheet : AppliedPoints
    historicalRateSheet : AppliedPoints
    keepLockEffectiveDate : boolean
    restrictDayLockPeriodCurrent : boolean
    restrictDayLockPeriodHistorical : boolean
    worseCase : AppliedPoints
    lockStatusPolicClosingSchedule : LockStatusPolicySchedule
    holidayExemptDates : Array[HolidayDate]
    lockExemptDates : Array[UsDateState]
    lockSaturday : boolean
    lockSunday : boolean
    lockTimeLockedToSpecificTimeZone : boolean
    lockTimeRanges : Array[UniversalRangeTime]
    lockedTimeZone : string
    lockStatusPolicySchedule : LockStatusPolicySchedule
    modifiedByOverride : string
    name : string
    revision : integer
    mainUserForEllieGroup : ObjectId
    mapOfRatePeriodDetail : object
    maxCompensationScript : string
    modifiedByOverride : string
    name : string
    overrideComplan : number
    overrideComplanFlatFee : number
    rateIds : Array[ObjectId]
    ratePeriodFilters : Array[RatePeriodFilter]
    rateSchedule : RateSchedule
    holidayExemptDates : Array[HolidayDate]
    lockExemptDates : Array[UsDateState]
    lockSaturday : boolean
    lockSunday : boolean
    lockTimeLockedToSpecificTimeZone : boolean
    lockTimeRanges : Array[UniversalRangeTime]
    lockedTimeZone : string
    roles : Array[string]
    roundingAsHoldback : boolean
    roundingBasePointAsHoldback : boolean
    roundingStrategy : string
    roundingStrategyOnAdjustments : boolean
    scriptWeight : integer
    start : string
    subject : string
    templateId : ObjectId
    type : string
    users : Array[ObjectId]
    Properties
    NameDescriptionData Type
     boolean
     string
     Array[ContactPerson]
     string
     boolean
     Array[ObjectId]
     Array[string]
     Array[string]
     Array[ObjectId]
     CreditDollarRange
     Array[CompanyAdjustmentGroup]
     Array[CompanyAdjustmentGroup]
     Array[CompanyAdjustmentGroup]
     ObjectId
     string
     boolean
     object
     string
     Array[CompanyMapping]
     string
     string
     object
     boolean
     boolean
     boolean
     string
     string
     number
     ObjectId
     LockStatusPolicy
     ObjectId
     object
     string
     string
     string
     number
     number
     Array[ObjectId]
     Array[RatePeriodFilter]
     RateSchedule
     Array[string]
     boolean
     boolean
     string
     boolean
     integer
     string
     string
     ObjectId
     string
     Array[ObjectId]
    See Also